/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.session.http;

import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.session.Session;

/**
 * Strategy interface for encoding {@link Session} IDs so they are represented in the response.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public interface HttpSessionIdEncoder {

    /**
     * Encode the given Session into the response. The strategy can choose to use headers, cookies or whatever strategy
     * suites the use case.
     *
     * @param request  The request
     * @param response The response
     * @param session  The session
     */
    void encodeId(HttpRequest<?> request, MutableHttpResponse<?> response, Session session);
}
